.\"
.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
.\" permission to reproduce portions of its copyrighted documentation.
.\" Original documentation from The Open Group can be obtained online at
.\" http://www.opengroup.org/bookstore/.
.\"
.\" The Institute of Electrical and Electronics Engineers and The Open
.\" Group, have given us permission to reprint portions of their
.\" documentation.
.\"
.\" In the following statement, the phrase ``this text'' refers to portions
.\" of the system documentation.
.\"
.\" Portions of this text are reprinted and reproduced in electronic form
.\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
.\" Standard for Information Technology -- Portable Operating System
.\" Interface (POSIX), The Open Group Base Specifications Issue 6,
.\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
.\" Engineers, Inc and The Open Group.  In the event of any discrepancy
.\" between these versions and the original IEEE and The Open Group
.\" Standard, the original IEEE and The Open Group Standard is the referee
.\" document.  The original Standard can be obtained online at
.\" http://www.opengroup.org/unix/online.html.
.\"
.\" This notice shall appear on any product containing this material.
.\"
.\" The contents of this file are subject to the terms of the
.\" Common Development and Distribution License (the "License").
.\" You may not use this file except in compliance with the License.
.\"
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
.\" or http://www.opensolaris.org/os/licensing.
.\" See the License for the specific language governing permissions
.\" and limitations under the License.
.\"
.\" When distributing Covered Code, include this CDDL HEADER in each
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
.\" If applicable, add the following below this CDDL HEADER, with the
.\" fields enclosed by brackets "[]" replaced with your own identifying
.\" information: Portions Copyright [yyyy] [name of copyright owner]
.\"
.\"
.\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
.\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
.\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
.\"
.TH PTHREAD_KEY_DELETE 3C "Mar 23, 2005"
.SH NAME
pthread_key_delete \- delete thread-specific data key
.SH SYNOPSIS
.LP
.nf
cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
#include <pthread.h>

\fBint\fR \fBpthread_key_delete\fR(\fBpthread_key_t\fR \fIkey\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBpthread_key_delete()\fR function deletes a thread-specific data key
previously returned by \fBpthread_key_create()\fR. The thread-specific data
values associated with \fIkey\fR need not be  \fINULL\fR at the time
\fBpthread_key_delete()\fR is called. It is the responsibility of the
application to free any application storage or perform any cleanup actions for
data structures related to the deleted key or associated thread-specific data
in any threads; this cleanup can be done either before or after
\fBpthread_key_delete()\fR is called. Any attempt to use \fIkey\fR following
the call to \fBpthread_key_delete()\fR results in undefined behaviour.
.sp
.LP
The \fBpthread_key_delete()\fR function is callable from within destructor
functions. No destructor functions will be invoked by
\fBpthread_key_delete()\fR. Any destructor function that may have been
associated with \fIkey\fR will no longer be called upon thread exit.
.SH RETURN VALUES
.sp
.LP
If successful, the \fBpthread_key_delete()\fR function returns  \fB0\fR.
Otherwise, an error number is returned to indicate the error.
.SH ERRORS
.sp
.LP
The \fBpthread_key_delete()\fR function may fail if:
.sp
.ne 2
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 10n
The \fIkey\fR value is invalid.
.RE

.sp
.LP
The \fBpthread_key_delete()\fR function will not return an error code of
\fBEINTR\fR.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Standard
_
MT-Level	MT-Safe
.TE

.SH SEE ALSO
.sp
.LP
.BR pthread_key_create (3C),
.BR attributes (7),
.BR standards (7)
